/* 
 * Shuriken is the legal property of its developers. Please refer to the
 * COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

using System;
using System.Collections.Generic;

namespace Shuriken.Core.Store
{
	/// <summary>
	/// IStore defines all the basis for all the store classes.
	/// </summary>
	public interface IStore
	{
        /// <summary>
        /// Category for the store
        /// </summary>
        string StoreCategory
        {
            get; 
        }

        /// <summary>
        /// Name for the store
        /// </summary>
        string StoreName
        {
            get; 
        }

        /// <summary>
        /// Store enabled 
        /// </summary>
        bool StoreEnabled
        {
            get;
            set; 
        }

        /// <summary>
        /// Number of items stored
        /// </summary>
        int Count
        {
            get; 
        }

        IStoreItem this[string index]
        {
            get;
            set;
        }

        Dictionary<string, IStoreItem>.KeyCollection Keys
        {
            get;
        }

        Dictionary<string, IStoreItem>.ValueCollection Values
        {
            get; 
        }

        /// <summary>
        /// Removes the given item from the store
        /// </summary>
        /// <param name="item">item to remove</param>
        void RemoveItem(IStoreItem item);

        int AddStoreItem(IStoreItem item);
	}
}
